<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Decompresses the entire Phar archive</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="phardata.copy.html">PharData::copy</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="phardata.decompressfiles.html">PharData::decompressFiles</a></div>
 <div class="up"><a href="class.phardata.html">PharData</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phardata.decompress" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">PharData::decompress</h1>
  <p class="verinfo">(PHP &gt;= 5.3.0, PECL phar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">PharData::decompress</span> &mdash; <span class="dc-title">Decompresses the entire Phar archive</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-phardata.decompress-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">object</span> <span class="methodname"><strong>PharData::decompress</strong></span>
    ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
  ] )</div>


  <p class="para rdfs-comment">
   For tar-based archives, this method decompresses the entire archive.
  </p>
  <p class="para">
   For Zip-based archives, this method fails with an exception.
   The <a href="ref.zlib.html" class="link">zlib</a> extension must be enabled to decompress
   an archive compressed with gzip compression, and the
   <a href="ref.bzip2.html" class="link">bzip2</a> extension must be
   enabled in order to decompress an archive compressed with bzip2 compression.
  </p>
  <p class="para">
   In addition, this method automatically renames the file extension of the archive,
   <em>.tar</em> by default.
   Alternatively, a file extension may be specified with the second
   parameter.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-phardata.decompress-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>
<em><code class="parameter">extension</code></em></dt>

     <dd>

      <p class="para">
       For decompressing, the default file extension
       is <em>.phar.tar</em>.
       Use this parameter to specify another file extension.  Be aware
       that no non-executable archives cannot contain <em>.phar</em>
       in their filename.
      </p>
     </dd>

    
   </dl>

  </p>

 </div>


 <div class="refsect1 returnvalues" id="refsect1-phardata.decompress-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   A <a href="class.phardata.html" class="classname">PharData</a> object is returned.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-phardata.decompress-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   Throws <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a> if
   the <a href="ref.zlib.html" class="link">zlib</a>
   extension is not available, or the <a href="ref.bzip2.html" class="link">bzip2</a> extension
   is not enabled.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-phardata.decompress-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-691">
    <p><strong>Example #1 A <span class="function"><strong>PharData::decompress()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$p&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/my.tar'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'my.tar.gz'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'myfile.txt'</span><span style="color: #007700">]&nbsp;=&nbsp;</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'myfile2.txt'</span><span style="color: #007700">]&nbsp;=&nbsp;</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p3&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$p2</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">decompress</span><span style="color: #007700">();&nbsp;</span><span style="color: #FF8000">//&nbsp;creates&nbsp;/path/to/my.tar<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-phardata.decompress-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="pharfileinfo.getcompressedsize.html" class="function" rel="rdfs-seeAlso">PharFileInfo::getCompressedSize()</a> - Returns the actual size of the file (with compression) inside the Phar archive</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.iscompressed.html" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressed()</a> - Returns whether the entry is compressed</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.compress.html" class="function" rel="rdfs-seeAlso">PharFileInfo::compress()</a> - Compresses the current Phar entry with either zlib or bzip2 compression</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.decompress.html" class="function" rel="rdfs-seeAlso">PharFileInfo::decompress()</a> - Decompresses the current Phar entry within the phar</span></li>
    <li class="member"><span class="function"><a href="phardata.compress.html" class="function" rel="rdfs-seeAlso">PharData::compress()</a> - Compresses the entire tar/zip archive using Gzip or Bzip2 compression</span></li>
    <li class="member"><span class="function"><a href="phar.cancompress.html" class="function" rel="rdfs-seeAlso">Phar::canCompress()</a> - Returns whether phar extension supports compression using either zlib or bzip2</span></li>
    <li class="member"><span class="function"><a href="phar.iscompressed.html" class="function" rel="rdfs-seeAlso">Phar::isCompressed()</a> - Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)</span></li>
    <li class="member"><span class="function"><a href="phardata.compress.html" class="function" rel="rdfs-seeAlso">PharData::compress()</a> - Compresses the entire tar/zip archive using Gzip or Bzip2 compression</span></li>
    <li class="member"><span class="function"><a href="phar.getsupportedcompression.html" class="function" rel="rdfs-seeAlso">Phar::getSupportedCompression()</a> - Return array of supported compression algorithms</span></li>
    <li class="member"><span class="function"><a href="phardata.compressfiles.html" class="function" rel="rdfs-seeAlso">PharData::compressFiles()</a> - Compresses all files in the current tar/zip archive</span></li>
    <li class="member"><span class="function"><a href="phardata.decompressfiles.html" class="function" rel="rdfs-seeAlso">PharData::decompressFiles()</a> - Decompresses all files in the current zip archive</span></li>
   </ul>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="phardata.copy.html">PharData::copy</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="phardata.decompressfiles.html">PharData::decompressFiles</a></div>
 <div class="up"><a href="class.phardata.html">PharData</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
